Skip to content

[Docs] Guide Cloud and self-hosted users through their first task - #3382

Merged
mrubens merged 3 commits into
developfrom
codex/docs-guided-onboarding
Oct 2, 2026
Merged

mrubens merged 3 commits into
developfrom
codex/docs-guided-onboarding

Conversation

@mrubens

@mrubens mrubens commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

What changed

Getting started now gives Roomote Cloud and self-hosting clear entry points, and both lead through a shared guide to a first successful repository task. The self-hosted path puts requirements before installation and explains how one deployment serves multiple computers.

  • Add a Cloud setup guide and a first-task walkthrough covering inference, repository access, sandbox execution, and reviewing results. Slack and other communications providers are explicitly optional.
  • Nest home-network and hosting-platform guides under self-hosting, with host preparation and networking instructions before install commands.
  • Move backup, upgrade, and troubleshooting reference material into an operations guide.
  • Align agent installation guidance with the same path, document Docker storage requirements, and replace the Quick Tunnel recommendation because it lacks the event streaming Roomote uses.

How it was tested

  • mise exec -- pnpm --filter @roomote/docs check: Mintlify build validation and broken-link checks passed; generated Cookbook content is current.
  • Reviewed the rendered local pages and home-network tabs at desktop and narrow widths.
  • Pre-push checks passed: oxlint, residual ESLint, check-types:fast, and knip.
  • The additional Judgement prose check remained incomplete: inference could not complete, and two pages exceeded its evidence budget. This is not a passing result.

@roomote-community

roomote-community Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

No code issues found. See task

  • apps/docs/first-task.mdx:90 Choosing I'll type it myself completes setup without creating the setup conversation the next step requires.

Reviewed e4ca1dc

Comment thread apps/docs/first-task.mdx Outdated
@mrubens
mrubens merged commit 80d01c8 into develop Oct 2, 2026
23 checks passed
@mrubens
mrubens deleted the codex/docs-guided-onboarding branch October 2, 2026 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant